mDocs Verifier SDK/global.mattr.mobilecredential.verifier/MobileCredentialVerifier

MobileCredentialVerifier

object MobileCredentialVerifier

The entry point for the MobileCredentialVerifier SDK.

Types

Link copied to clipboard
enum SdkState : Enum<MobileCredentialVerifier.SdkState>

Enum class to represent all possible Verifier SDK states.

Properties

Link copied to clipboard
val initialized: Boolean

Functions

Link copied to clipboard
@Blocking
fun addTrustedIssuerCertificates(certificates: List<String>): List<String>

Add a trusted issuer certificate to storage.

Link copied to clipboard
fun createProximityPresentationSession(activity: Activity, qrEncodedDeviceEngagementString: String, listener: ProximityPresentationSessionListener)

Create a proximity-based presentation session with a mobile credential holder using device retrieval as per ISO/IEC 18013-5:2021.

Link copied to clipboard
suspend fun deinitialize()

Deinitialize the MobileCredentialVerifier SDK.

Link copied to clipboard
@Blocking
fun deleteTrustedIssuerCertificate(id: String)

Delete a trusted issuer certificate from storage.

Link copied to clipboard
fun deregisterForNfcDeviceEngagement(activity: Activity)

Disables NFC engagement and deregisters any previously registered callbacks.

Link copied to clipboard
fun getLog(): String?

Close and return the full address of the current log file.

Link copied to clipboard
@Blocking
fun getTrustedIssuerCertificates(): List<TrustedCertificate>

Retrieve all trusted issuer certificates from storage.

Link copied to clipboard
@Blocking
fun getTrustedIssuerStatusListsCacheInfo(): TrustedIssuerStatusListsCacheInfo

Get current revocation status lists cache information without updating the status lists.

Link copied to clipboard
suspend fun initialize(activity: Activity, loggerConfiguration: Logger.LoggerConfiguration? = null)

Initialize the MobileCredentialVerifier SDK.

Link copied to clipboard
fun isValidDeviceEngagementString(data: String): Boolean

Validates the supplied string is a valid QR code based on device engagement structure (as per section 8.2.2.3 of ISO 18013-5).

Link copied to clipboard
fun registerForNfcDeviceEngagement(activity: Activity, listener: ProximityPresentationSessionListener): Boolean

Registers for NFC-based device engagement and enables it.

Link copied to clipboard
suspend fun sendProximityPresentationRequest(    request: List<MobileCredentialRequest>,     skipStatusCheck: Boolean = false): MobileCredentialResponse

This function uses the requested mobile credentials to construct and send a presentation request to the holder. This new function, replaces the old ProximityPresentationSession.requestMobileCredentials.

Link copied to clipboard
suspend fun terminateProximityPresentationSession()

Terminate the session explicitly, send status code sessionTerminated to the holder, and close data transport.

Link copied to clipboard
@Blocking
fun updateTrustedIssuerStatusLists(): UpdateTrustedIssuerStatusListsResult

Update trusted issuer status lists.